<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>DRV_SPI_TRANSFER_EVENT Enumeration</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00506.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00137.html" target="topic">SPI Driver Library Help</a> &gt; <a href="00138.html" target="topic">Library Interface</a> &gt; e) Data Types and Constants &gt; <a href="00506.html" target="topic">DRV_SPI_TRANSFER_EVENT Enumeration</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00515.html" target="topic">Previous</a> | <a href="00138.html" target="topic">Up</a> | <a href="00513.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SPI_TRANSFER_EVENT Topic Title: DRV_SPI_TRANSFER_EVENT Enumeration)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
DRV_SPI_TRANSFER_EVENT Enumeration</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
SPI Driver Transfer Events&nbsp;</p>
<p class="Element10">
This enumeration identifies the possible events that can result from a transfer add request caused by the client calling either <a href="00504.html" target="topic">DRV_SPI_ReadTransferAdd</a> or <a href="00528.html" target="topic">DRV_SPI_WriteTransferAdd</a> or <a href="00526.html" target="topic">DRV_SPI_WriteReadTransferAdd</a> functions.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><strong><span style="color: #000080">typedef</span></strong> <strong><span style="color: #000080">enum</span></strong> {
  <strong><span style="color: #000000">DRV_SPI_TRANSFER_EVENT_PENDING</span></strong>,
  <strong><span style="color: #000000">DRV_SPI_TRANSFER_EVENT_COMPLETE</span></strong>,
  <strong><span style="color: #000000">DRV_SPI_TRANSFER_EVENT_HANDLE_EXPIRED</span></strong>,
  <strong><span style="color: #000000">DRV_SPI_TRANSFER_EVENT_ERROR</span></strong>,
  <strong><span style="color: #000000">DRV_SPI_TRANSFER_EVENT_HANDLE_INVALID</span></strong>
} DRV_SPI_TRANSFER_EVENT;</pre></div></div>
<a name="4D656D62657273"></a><div class="Element14">
Members</div>
<div class="Element11">
<div class="Element10">
<div class="Element272">
<div class="TableDiv">
<table cellspacing="0" class="Table1">
<tr>
<td class="Element260" valign="top" width="35%">
<div class="Element261">
Members&nbsp;</div></td><td class="Element264" valign="top" width="65%">
<div class="Element265">
Description&nbsp;</div></td></tr><tr>
<td class="Element262" valign="top" width="35%">
<div class="Element263">
DRV_SPI_TRANSFER_EVENT_PENDING&nbsp;</div></td><td class="Element266" valign="top" width="65%">
<div class="Element267">
Transfer request is pending&nbsp;</div></td></tr><tr>
<td class="Element262" valign="top" width="35%">
<div class="Element263">
DRV_SPI_TRANSFER_EVENT_COMPLETE&nbsp;</div></td><td class="Element266" valign="top" width="65%">
<div class="Element267">
All data were transfered successfully.&nbsp;</div></td></tr><tr>
<td class="Element262" valign="top" width="35%">
<div class="Element263">
DRV_SPI_TRANSFER_EVENT_HANDLE_EXPIRED&nbsp;</div></td><td class="Element266" valign="top" width="65%">
<div class="Element267">
Transfer Handle given is expired. It means transfer is completed but with or without error is not known. In case of Non-DMA transfer, since there is no possibility of error, it can be assumed same as DRV_SPI_TRANSFER_EVENT_COMPLETE&nbsp;</div></td></tr><tr>
<td class="Element262" valign="top" width="35%">
<div class="Element263">
DRV_SPI_TRANSFER_EVENT_ERROR&nbsp;</div></td><td class="Element266" valign="top" width="65%">
<div class="Element267">
There was an error while processing transfer request.&nbsp;</div></td></tr><tr>
<td class="Element262" valign="top" width="35%">
<div class="Element263">
DRV_SPI_TRANSFER_EVENT_HANDLE_INVALID&nbsp;</div></td><td class="Element266" valign="top" width="65%">
<div class="Element267">
Transfer Handle given is invalid&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
Either DRV_SPI_TRANSFER_EVENT_COMPLETE or DRV_SPI_TRANSFER_EVENT_ERROR is passed in the &quot;event&quot; parameter of the event handling callback function that the client registered with the driver by calling the <a href="00522.html" target="topic">DRV_SPI_TransferEventHandlerSet</a> function when a transfer request is completed.&nbsp;</p>
<p class="Element10">
When status polling is used, any one of these events is returned by <a href="00524.html" target="topic">DRV_SPI_TransferStatusGet</a> function.</p></div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00137.html" target="topic">SPI Driver Library Help</a> &gt; <a href="00138.html" target="topic">Library Interface</a> &gt; e) Data Types and Constants &gt; <a href="00506.html" target="topic">DRV_SPI_TRANSFER_EVENT Enumeration</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00515.html" target="topic">Previous</a> | <a href="00138.html" target="topic">Up</a> | <a href="00513.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SPI_TRANSFER_EVENT Topic Title: DRV_SPI_TRANSFER_EVENT Enumeration)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>